Skip to content

docs: Add GitHub Copilot authentication requirement to README #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

ejones-unity
Copy link

Summary

This PR addresses the confusion around GitHub Copilot authentication requirements when setting up the GitHub MCP Server.

Changes

  • Added a prerequisite note in the README explaining that GitHub Copilot authentication is required for the remote server
  • Clarified that the remote server is hosted at api.githubcopilot.com and requires a Copilot subscription

Problem

As mentioned in issue #555, users were experiencing confusion during setup because:

  • The README didn't explicitly mention the GitHub Copilot authentication requirement
  • Users had to figure this out through trial and error
  • The only hint was the api.githubcopilot.com URL in the configuration

Solution

Added clear documentation in the Prerequisites section to help users understand the authentication requirements upfront, preventing setup confusion.

Fixes #555

- Add prerequisite note about GitHub Copilot authentication requirement
- Clarify that remote server requires Copilot subscription and authentication
- Addresses confusion mentioned in issue github#555
@ejones-unity ejones-unity requested a review from a team as a code owner June 20, 2025 13:12
@SamMorrowDrums
Copy link
Collaborator

Hi @ejones-unity I believe that was a testing gap, as the subset of user's without a license with Copilot Free is much lower. We will look at the auth middleware stack and remove any requirement of a license.

@LuluBeatson
Copy link
Contributor

Hi @ejones-unity, thank you raising this. A Copilot license is no longer required to access the remote server. We fixed this last week

We have also been working to improve the README and been adding installation guides for different hosts.

If you think anything else is missing please let us know :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README is missing GitHub Copilot authentication requirement
3 participants